/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.catalina.core;

import java.io.IOException;
import java.util.Locale;

import javax.servlet.http.Cookie;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpServletResponseWrapper;

import org.apache.catalina.util.StringManager;

/**
 * Wrapper around a <code>javax.servlet.http.HttpServletResponse</code> that
 * transforms an application response object (which might be the original one
 * passed to a servlet, or might be based on the 2.3
 * <code>javax.servlet.http.HttpServletResponseWrapper</code> class) back into
 * an internal <code>org.apache.catalina.HttpResponse</code>.
 * <p>
 * <strong>WARNING</strong>: Due to Java's lack of support for multiple
 * inheritance, all of the logic in <code>ApplicationResponse</code> is
 * duplicated in <code>ApplicationHttpResponse</code>. Make sure that you keep
 * these two classes in synchronization when making changes!
 * 
 * @author Craig R. McClanahan
 * @version $Id: ApplicationHttpResponse.java 939336 2010-04-29 15:00:41Z
 *          kkolinko $
 */

class ApplicationHttpResponse extends HttpServletResponseWrapper {

	// ----------------------------------------------------------- Constructors

	/**
	 * Construct a new wrapped response around the specified servlet response.
	 * 
	 * @param response
	 *            The servlet response being wrapped
	 */
	public ApplicationHttpResponse(HttpServletResponse response) {

		this(response, false);

	}

	/**
	 * Construct a new wrapped response around the specified servlet response.
	 * 
	 * @param response
	 *            The servlet response being wrapped
	 * @param included
	 *            <code>true</code> if this response is being processed by a
	 *            <code>RequestDispatcher.include()</code> call
	 */
	public ApplicationHttpResponse(HttpServletResponse response,
			boolean included) {

		super(response);
		setIncluded(included);

	}

	// ----------------------------------------------------- Instance Variables

	/**
	 * Is this wrapped response the subject of an <code>include()</code> call?
	 */
	protected boolean included = false;

	/**
	 * Descriptive information about this implementation.
	 */
	protected static final String info = "org.apache.catalina.core.ApplicationHttpResponse/1.0";

	/**
	 * The string manager for this package.
	 */
	protected static StringManager sm = StringManager
			.getManager(Constants.Package);

	// ------------------------------------------------ ServletResponse Methods

	/**
	 * Disallow <code>reset()</code> calls on a included response.
	 * 
	 * @exception IllegalStateException
	 *                if the response has already been committed
	 */
	public void reset() {

		// If already committed, the wrapped response will throw ISE
		if (!included || getResponse().isCommitted())
			getResponse().reset();

	}

	/**
	 * Disallow <code>setContentLength()</code> calls on an included response.
	 * 
	 * @param len
	 *            The new content length
	 */
	public void setContentLength(int len) {

		if (!included)
			getResponse().setContentLength(len);

	}

	/**
	 * Disallow <code>setContentType()</code> calls on an included response.
	 * 
	 * @param type
	 *            The new content type
	 */
	public void setContentType(String type) {

		if (!included)
			getResponse().setContentType(type);

	}

	/**
	 * Disallow <code>setLocale()</code> calls on an included response.
	 * 
	 * @param loc
	 *            The new locale
	 */
	public void setLocale(Locale loc) {

		if (!included)
			getResponse().setLocale(loc);

	}

	/**
	 * Ignore <code>setBufferSize()</code> calls on an included response.
	 * 
	 * @param size
	 *            The buffer size
	 */
	public void setBufferSize(int size) {
		if (!included)
			getResponse().setBufferSize(size);
	}

	// -------------------------------------------- HttpServletResponse Methods

	/**
	 * Disallow <code>addCookie()</code> calls on an included response.
	 * 
	 * @param cookie
	 *            The new cookie
	 */
	public void addCookie(Cookie cookie) {

		if (!included)
			((HttpServletResponse) getResponse()).addCookie(cookie);

	}

	/**
	 * Disallow <code>addDateHeader()</code> calls on an included response.
	 * 
	 * @param name
	 *            The new header name
	 * @param value
	 *            The new header value
	 */
	public void addDateHeader(String name, long value) {

		if (!included)
			((HttpServletResponse) getResponse()).addDateHeader(name, value);

	}

	/**
	 * Disallow <code>addHeader()</code> calls on an included response.
	 * 
	 * @param name
	 *            The new header name
	 * @param value
	 *            The new header value
	 */
	public void addHeader(String name, String value) {

		if (!included)
			((HttpServletResponse) getResponse()).addHeader(name, value);

	}

	/**
	 * Disallow <code>addIntHeader()</code> calls on an included response.
	 * 
	 * @param name
	 *            The new header name
	 * @param value
	 *            The new header value
	 */
	public void addIntHeader(String name, int value) {

		if (!included)
			((HttpServletResponse) getResponse()).addIntHeader(name, value);

	}

	/**
	 * Disallow <code>sendError()</code> calls on an included response.
	 * 
	 * @param sc
	 *            The new status code
	 * 
	 * @exception IOException
	 *                if an input/output error occurs
	 */
	public void sendError(int sc) throws IOException {

		if (!included)
			((HttpServletResponse) getResponse()).sendError(sc);

	}

	/**
	 * Disallow <code>sendError()</code> calls on an included response.
	 * 
	 * @param sc
	 *            The new status code
	 * @param msg
	 *            The new message
	 * 
	 * @exception IOException
	 *                if an input/output error occurs
	 */
	public void sendError(int sc, String msg) throws IOException {

		if (!included)
			((HttpServletResponse) getResponse()).sendError(sc, msg);

	}

	/**
	 * Disallow <code>sendRedirect()</code> calls on an included response.
	 * 
	 * @param location
	 *            The new location
	 * 
	 * @exception IOException
	 *                if an input/output error occurs
	 */
	public void sendRedirect(String location) throws IOException {

		if (!included)
			((HttpServletResponse) getResponse()).sendRedirect(location);

	}

	/**
	 * Disallow <code>setDateHeader()</code> calls on an included response.
	 * 
	 * @param name
	 *            The new header name
	 * @param value
	 *            The new header value
	 */
	public void setDateHeader(String name, long value) {

		if (!included)
			((HttpServletResponse) getResponse()).setDateHeader(name, value);

	}

	/**
	 * Disallow <code>setHeader()</code> calls on an included response.
	 * 
	 * @param name
	 *            The new header name
	 * @param value
	 *            The new header value
	 */
	public void setHeader(String name, String value) {

		if (!included)
			((HttpServletResponse) getResponse()).setHeader(name, value);

	}

	/**
	 * Disallow <code>setIntHeader()</code> calls on an included response.
	 * 
	 * @param name
	 *            The new header name
	 * @param value
	 *            The new header value
	 */
	public void setIntHeader(String name, int value) {

		if (!included)
			((HttpServletResponse) getResponse()).setIntHeader(name, value);

	}

	/**
	 * Disallow <code>setStatus()</code> calls on an included response.
	 * 
	 * @param sc
	 *            The new status code
	 */
	public void setStatus(int sc) {

		if (!included)
			((HttpServletResponse) getResponse()).setStatus(sc);

	}

	/**
	 * Disallow <code>setStatus()</code> calls on an included response.
	 * 
	 * @param sc
	 *            The new status code
	 * @param msg
	 *            The new message
	 */
	public void setStatus(int sc, String msg) {

		if (!included)
			((HttpServletResponse) getResponse()).setStatus(sc, msg);

	}

	// -------------------------------------------------------- Package Methods

	/**
	 * Return descriptive information about this implementation.
	 */
	public String getInfo() {

		return (info);

	}

	/**
	 * Return the included flag for this response.
	 */
	boolean isIncluded() {

		return (this.included);

	}

	/**
	 * Set the included flag for this response.
	 * 
	 * @param included
	 *            The new included flag
	 */
	void setIncluded(boolean included) {

		this.included = included;

	}

	/**
	 * Set the response that we are wrapping.
	 * 
	 * @param response
	 *            The new wrapped response
	 */
	void setResponse(HttpServletResponse response) {

		super.setResponse(response);

	}

}
